Return Network Information

 

Command:

To return information about the Ethernet Host and Management Ports

The HSM will record details about network activity on both its Management and Host Ethernet ports for diagnostic and security purposes. As a diagnostic aid, it can provide useful information when configuring the unit. If reviewed periodically, it can also provide evidence of unexpected network activity, which may require further investigation.

The HSM collects information about each ‘endpoint’ that communicates with it. The information recorded will depend on the particular protocol that was used to send the packet.

For TCP packets, the HSM records:

·                Local TCP port

·                Remote IP address and TCP port

·      TCP state (e.g. LISTENING, ESTABLISHED, etc.)

·                Timestamp (time when connection was initiated)

For UDP packets, the HSM records:

·                Local UDP port

·                Remote IP address and UDP port

·                Timestamp (time of most recent UDP packet received from this address)

The HSM console command “NETSTAT” provides the same information at the console.

Notes:

Support for other Host connections is not currently provided

 

Field

Length & Type

Details

COMMAND MESSAGE

Message Header

m A

Will be returned to the Host unchanged

Command Code

2 A

Value “NI”

Network Interface

1 A

‘H’ – Host Port

‘M’ – Management Port

Ethernet Statistics

  

1 N

‘0’ – Do not return Ethernet statistics

‘1’ – Return Ethernet statistics

End Message Delimiter

1 C

  

Optional. Must be present if a message trailer is present. Value X'19

Message Trailer

n A

Optional. Maximum length 32 characters

RESPONSE MESSAGE

Message Header

m A

Will be returned to the Host unchanged

Response Code

2 A

Value “NJ”

Error Code

2 N

00 – No error

15 – Error in input data

81 – Invalid Network Interface value

82 – Invalid Ethernet Statistics value

Number Of Records

4 N

Number of records to follow (‘N’). Each record consists of up to 6 fields, as below:

Record #1

Protocol

1 N

The protocol of the recorded packet.

0 – TCP

1 – UDP

2..9 – Reserved

Local Port

4 H

The port number at this HSM.

Only present if Protocol = 1 or 2 (UDP or TCP).

Remote Address

8 H

The IP address of the remote node, for example:

C1F06541 = 193.240.101.65

Remote Port

4 H

The port number at the remote IP address.

Only present if Protocol = 1 or 2 (UDP or TCP).

State

1 N

The TCP state of the connection.

0 – ESTABLISHED

1 – CLOSED

2..9 – Reserved

Only present if Protocol = 2 (TCP).

Duration

8 N

Time (in seconds) since the connection was initiated (for TCP), or since the most recent packet was received from the specified IP address (and port – for UDP).

Record #2

Protocol

1 N

As above

Local Port

4 H

As above

Remote Address

8 H

As above

Remote Port

4 H

As above         

State

1 N

As above

Duration

8 N

As above

  

“

“

“

Record #N

Protocol

1 N

As above

Local Port

4 H

As above

Remote Address

8 H

As above

Remote Port

4 H

As above

State

1 N

As above

Duration

8 N

As above

Total Bytes Sent

  

16 H

Number of bytes sent on the specified interface.

Only present if Ethernet Statistics is ‘1’.

Total Bytes Received

  

16 H

Number of bytes received on the specified interface.

Only present if Ethernet Statistics is ‘1’.

Total Unicast Packets Sent

8 H

Number of non-broadcast packets sent on the specified interface.

Only present if Ethernet Statistics is ‘1’.

Total Unicast Packets Received

8 H

Number of non-broadcast packets received on the specified interface.

Only present if Ethernet Statistics is ‘1’.

Total Non-unicast packets Sent

8 H

Number of broadcast packets sent on the specified interface.

Only present if Ethernet Statistics is ‘1’.

Total Non-unicast packets Received

8 H

Number of broadcast packets received on the specified interface.

Only present if Ethernet Statistics is ‘1’.

Total Errors During Send

8 H

Number of errors detected during send operations on the specified interface.

Only present if Ethernet Statistics is ‘1’.

Total Errors During Receive

8 H

Number of errors detected during receive operations on the specified interface.

Only present if Ethernet Statistics is ‘1’.

Total Unknown Packets

8 H

Number of unknown protocols detected during receive operations on the specified interface.

Only present if Ethernet Statistics is ‘1’.

End Message Delimiter

1 C

Will only be present if present in the command message. Value X'19

Message Trailer

N A

 

Will only be present if in the command message. Maximum length 32 characters